org.eclipse.vtp.framework.common.configurations
Class DataTypeConfiguration

java.lang.Object
  extended by org.eclipse.vtp.framework.common.configurations.DataTypeConfiguration
All Implemented Interfaces:
CommonConstants, IConfiguration

public class DataTypeConfiguration
extends java.lang.Object
implements IConfiguration, CommonConstants

A configuration for an entry in the data type registry.

Author:
Lonnie Pryor

Field Summary
 
Fields inherited from interface org.eclipse.vtp.framework.common.configurations.CommonConstants
MAPPING_TYPE_EXPRESSION, MAPPING_TYPE_NONE, MAPPING_TYPE_STATIC, MAPPING_TYPE_VARIABLE, NAME_ASSIGNMENT, NAME_BRANCH, NAME_BRAND, NAME_DATA_TYPE, NAME_DISPATCH, NAME_ENTRY, NAME_EXIT, NAME_FIELD, NAME_INITIAL_VALUE, NAME_KEY, NAME_LEFT_OPERAND, NAME_NAME, NAME_OUTGOING, NAME_PATH, NAME_PRIMARY_FIELD, NAME_RIGHT_OPERAND, NAME_SCRIPT, NAME_SCRIPTING_LANGUGAGE, NAME_TYPE, NAME_URI, NAME_VALUE, NAME_VARIABLE_MAPPING, NAMESPACE_URI
 
Constructor Summary
DataTypeConfiguration()
          Creates a new DataTypeConfiguration.
 
Method Summary
 void addField(FieldConfiguration field)
          Adds a field to this type.
 FieldConfiguration[] getFields()
          Returns the fields declared in this type.
 java.lang.String getName()
          Returns the name of this type.
 java.lang.String getPrimaryField()
          Returns the name of the primary field of this type.
 void load(org.w3c.dom.Element configurationElement)
          Loads the configuration information from the specified XML element.
 void removeField(FieldConfiguration field)
          Removes a field from this type.
 void save(org.w3c.dom.Element configurationElement)
          Saves the configuration information into the supplied XML element.
 void setName(java.lang.String name)
          Sets the name of this type.
 void setPrimaryField(java.lang.String primaryField)
          Sets the name of the primary field of this type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DataTypeConfiguration

public DataTypeConfiguration()
Creates a new DataTypeConfiguration.

Method Detail

getName

public java.lang.String getName()
Returns the name of this type.

Returns:
The name of this type.

setName

public void setName(java.lang.String name)
Sets the name of this type.

Parameters:
name - The name of this type.

getPrimaryField

public java.lang.String getPrimaryField()
Returns the name of the primary field of this type.

Returns:
The name of the primary field of this type.

setPrimaryField

public void setPrimaryField(java.lang.String primaryField)
Sets the name of the primary field of this type.

Parameters:
primaryField - The name of the primary field of this type.

getFields

public FieldConfiguration[] getFields()
Returns the fields declared in this type.

Returns:
The fields declared in this type.

addField

public void addField(FieldConfiguration field)
Adds a field to this type.

Parameters:
field - The field to add.

removeField

public void removeField(FieldConfiguration field)
Removes a field from this type.

Parameters:
field - The field to remove.

load

public void load(org.w3c.dom.Element configurationElement)
Description copied from interface: IConfiguration
Loads the configuration information from the specified XML element.

Specified by:
load in interface IConfiguration
Parameters:
configurationElement - The element to load the configuration from.

save

public void save(org.w3c.dom.Element configurationElement)
Description copied from interface: IConfiguration
Saves the configuration information into the supplied XML element.

Specified by:
save in interface IConfiguration
Parameters:
configurationElement - The element to save the configuration to.